Salesforce UX API

This operation is used to pass the confirmation to Aria that the account suspend/resume due to dunning

Note - To work this functionality accountType & state should be mandatory

• For the 'state' the expected values will be Suspended (for account suspended communication ) / un-suspended (for account resume communication )
• For the 'accountType' the expected values will be SuspendedAccount / unSuspendedAccount, this will be not passed to Aria (using ESB internal to avoid routing conflict )

/billingAccount/{id} [PATCH]

URL

https://[localhost]:[port]/sfdc-ux/v1/{businessId}/billingAccount/{id}

url Param

Header

Request

Suspend account

curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/billingAccount/ban-can' \
--header 'X-Correlation-Id: 1234567' \
--header 'client_id: 12abc' \
--header 'client_secret: 34abc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountType": "SuspendedAccount"
    "state": "Suspended",    /suspend_flag
    "accountRelationship": [
        {
            "relationshipType": "contains",
            "account": {
                "id": "BAN-CAN-MPI",    /plan_instance_id
                "description": "Account Master Plan Instance ID"
            }
        }
    ]
}'

un-Suspend / resume account

curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/sfdc-ux/sfdc-ux/v1/PR/billingAccount/ban-can' \
--header 'X-Correlation-Id: 1234567' \
--header 'client_id: 12abc' \
--header 'client_secret: 34abc' \
--header 'Content-Type: application/json' \
--data-raw '{
    "accountType": "unSuspendedAccount"
    "state": "un-suspended",        /suspend_flag
    "accountRelationship": [
        {
            "relationshipType": "contains",
            "account": {
                "id": "BAN-CAN-MPI",    /plan_instance_id
                "description": "Account Master Plan Instance ID"
            }
        }
    ]
}'

Request Definitions

Each of the request parameters is detailed.

Note - To work this functionality the "state" & "accountType" will be expected.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - update request processed successfully, response body contains an entity corresponding to the requested resource.

Response

{
    "state": "Suspended",
    "description": "SUCCESS.\r\n\r\nNo line item (service) found in the invoice 1203282468 that is marked to be credited upon suspend / resume / upkeep. No credit memo created."
}

Response Definitions

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "Bad Request",
      "description" : "The request is invalid or not properly formed."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method PATCH not allowed for : /{businessId}/billingAccount/{id}"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": ""
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /billingAccount/{id} for Business Id: xxxx not implemented"
    }]
  }